ReadFrames(RasterCodecs,string,List<int>,int,CodecsLoadByteOrder) Method

Summary

Loads the specified frame images (i.e. CompositeJpxImages.ColorImage, CompositeJpxImages.OpacityImage, and CompositeJpxImages.PreOpacityImage) from the specified JPEG 2000 file using the specified options.

Syntax

C++/CLI

Python

public List<CompositeJpxImages> ReadFrames( 
   RasterCodecs codecs, 
   string fileName, 
   List<int> frames, 
   int bitsPerPixel, 
   CodecsLoadByteOrder order 
)

public: 
List<CompositeJpxImages^>^ ReadFrames(  
   RasterCodecs^ codecs, 
   String^ fileName, 
   List<int>^ frames, 
   int bitsPerPixel, 
   CodecsLoadByteOrder order 
)

def ReadFrames(self,codecs,fileName,frames,bitsPerPixel,order):

Parameters

codecs
The Leadtools.Codecs.RasterCodecs object.

fileName
System.String containing the name of the JPEG 2000 image file which has the frames being loaded.

frames
Frame indices. A list of integers specifying the indices of the frames to be loaded from the file.

bitsPerPixel
Resulting image pixel depth. If this value is zero [0], the image will have the original file's pixel depth (the image will not be converted).

order
Color order for 16-bit, 24-bit, 32-bit, 48-bit, and 64-bit images. If the resulting image is less than 16 bits per pixel, this will have no effect since palletized images do not use color order. Valid values are as follows:

Value	Meaning
CodecsLoadByteOrder.Rgb	Red, green, and blue color order in memory
CodecsLoadByteOrder.Bgr	Blue, green, and red color order in memory
CodecsLoadByteOrder.Gray	12-bit or 16-bit grayscale image. 12-bit and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RgbOrGray	Load the image as red, green, blue OR as a 12-bit or 16-bit grayscale image. 12-bit and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.BgrOrGray	Load the image as blue, green, red OR as a 12-bit or 16-bit grayscale image. 12-bit and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.Romm	ROMM order. ROMM only supports 24-bit and 48-bit images.
CodecsLoadByteOrder.BgrOrGrayOrRomm	Load the image as red, green, blue OR as a 12-bit or 16-bit grayscale image OR as ROMM. 12-bit and 16-bit grayscale images are supported only in the Document/Medical Imaging editions. ROMM only supports 24-bit and 48-bit color images.

Return Value

The CompositeJpxImages list that this method loads.

Remarks

All engine boxes will be reset.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Jpeg2000; 
 
 
public void ReadFramesStringExample() 
{ 
   // Load a JPEG 2000 image 
   Jpeg2000Engine engine = new Jpeg2000Engine(); 
   Jpeg2000FileInformation fileInfo = engine.GetFileInformation(Path.Combine(LEAD_VARS.ImagesDir, "image1.jpx")); 
   if (fileInfo.Frame.GetLength(0) < 2) 
      return; 
 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
   List<int> frames = new List<int>(); 
   frames.Add(1); 
   List<CompositeJpxImages> images = engine.ReadFrames(codecs, Path.Combine(LEAD_VARS.ImagesDir, "image1.jpx"), frames, 0, CodecsLoadByteOrder.BgrOrGray); 
   // Clean up 
   foreach (CompositeJpxImages image in images) 
   { 
      if (image.ColorImage != null) 
         image.ColorImage.Dispose(); 
 
      if (image.OpacityImage != null) 
         image.OpacityImage.Dispose(); 
 
      if (image.PreOpacityImage != null) 
         image.PreOpacityImage.Dispose(); 
   } 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}